Skip to content

Add CI workflow to test CITE compliance #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 42 commits into
base: master
Choose a base branch
from

Conversation

ricardogsilva
Copy link
Member

@ricardogsilva ricardogsilva commented May 12, 2025

Overview

This PR introduces a new CI workflow for running CITE-related tests in an automated fashion.

This GitHub workflow file stands up a new docker compose stack which serves the purpose of readying pygeoapi for being tested. I am using a docker compose file with the intention of both:

  • Adding further services in the future and test them together. Ex: Also standing up an elasticsearch server and use it as a features provider
  • Being able to replicate the execution locally in the same conditions as done on GitHub CI

The actual CITE testing is done by using the new cite-runner project, which I have been developing. It has now reached a level of maturity where it can be used reliably and its principal motivation for existing was to satisfy this type of workflow.

Important

I don't think this PR is ready to be merged just yet, but I'm opening it now in order to get some eyeballs on it and hopefully generate some discussion about it.

Included in the workflow is a matrix for running CITE tests for all of these test suites:

  • OGC API Features
  • OGC API Processes
  • OGC API Tiles
  • OGC API EDR

The workflow is configured to fail if any of these test suites fail - and this is indeed happening. My intention is just to demonstrate a possible usage pattern for pygeoapi but I am not actually advocating that we merge this PR like this 😛 . The current CITE test configuration that is included in pygeoapi repo, and which I am also reusing in this PR, does not really include resources for performing successful tests of all these test suites.

Perhaps the optimal strategy would be to ship only tests for OGC API Features for now.

Another option would be to keep all these test suites in effect, but rather modify the GitHub workflow so that it does not fail. In this way we could treat this new CITE testing workflow as merely informative.

Another option might be to set the workflow up so that it runs on a fixed schedule (maybe once per day) and uses the pygeoapi demo instance instead of running on each commit to the master branch.

Anyway, the idea is that this workflow provides a nice test execution report on the GitHub actions workflow run page. See for example the result of this PR's checks here:

https://github.com/geopython/pygeoapi/actions/runs/14978028515

It looks like this:

image

The logs also provide a more comprehensive report, as seen in this screenshot I just took from them:

image

Related Issue / discussion

Additional information

Dependency policy (RFC2)

  • I have ensured that this PR meets RFC2 requirements

Updates to public demo

Contributions and licensing

(as per https://github.com/geopython/pygeoapi/blob/master/CONTRIBUTING.md#contributions-and-licensing)

  • I'd like to contribute [feature X|bugfix Y|docs|something else] to pygeoapi. I confirm that my contributions to pygeoapi will be compatible with the pygeoapi license guidelines at the time of contribution
  • I have already previously agreed to the pygeoapi Contributions and Licensing Guidelines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant